package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SalaryChangesAddDTO;
import org.jsola.hr.dto.SalaryChangesUpdateDTO;
import org.jsola.hr.query.SalaryChangesQuery;
import org.jsola.hr.vo.SalaryChangesListVO;
import org.jsola.hr.vo.SalaryChangesVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-员工调薪记录")
public interface ISalaryChangesControllerAPI {

    /**
     * 新增员工调薪记录
     * @param salaryChangesAddDTO 员工调薪记录新增实体
     * @return 员工调薪记录展示对象
     */
    @ApiOperation(value = "新增员工调薪记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryChangesAddDTO", dataType = "SalaryChangesAddDTO", value = "新增员工调薪记录", paramType = "body")
    })
    Result<SalaryChangesVO> save(SalaryChangesAddDTO salaryChangesAddDTO);


    /**
     * 修改员工调薪记录
     * @param salaryChangesUpdateDTO 员工调薪记录
     * @return 更新数量
     */
    @ApiOperation(value = "修改员工调薪记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryChangesUpdateDTO", dataType = "SalaryChangesUpdateDTO", value = "修改员工调薪记录", paramType = "body")
    })
    Result<Integer> update(SalaryChangesUpdateDTO salaryChangesUpdateDTO);




    /**
     * 删除单个员工调薪记录，彻底删除
     * @param salaryChangesId 员工调薪记录id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个员工调薪记录，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryChangesId", dataType = "String", value = "员工调薪记录id", paramType = "path")
    })
    Result<Integer> delete(String salaryChangesId);


    /**
     * 批量删除员工调薪记录，彻底删除
     * @param salaryChangesIds 员工调薪记录id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除员工调薪记录，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryChangesIds", dataType = "String[]", value = "员工调薪记录id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] salaryChangesIds);


    /**
     * 根据员工调薪记录id查询员工调薪记录详情
     * @param salaryChangesId 员工调薪记录id
     * @return 员工调薪记录详情
     */
    @ApiOperation(value="根据员工调薪记录id查询员工调薪记录详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryChangesId", dataType = "String", value = "员工调薪记录id", paramType = "path")
    })
    Result<SalaryChangesVO> findById(String salaryChangesId);


    /**
     * 查询员工调薪记录
     * @param salaryChangesQuery 员工调薪记录查询参数
     * @return page
     */
    @ApiOperation(value="查询员工调薪记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryChangesQuery", dataType = "SalaryChangesQuery", value = "员工调薪记录查询参数", paramType = "query")
    })
    Result<List<SalaryChangesListVO>> listAll(SalaryChangesQuery salaryChangesQuery);


     /**
     * 分页查询员工调薪记录
     * @param salaryChangesQuery 员工调薪记录查询参数
     * @return page
     */
    @ApiOperation(value="分页查询员工调薪记录")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "salaryChangesQuery", dataType = "SalaryChangesQuery", value = "员工调薪记录查询参数", paramType = "query")
    })
    Result<Page<SalaryChangesListVO>> page(SalaryChangesQuery salaryChangesQuery);

    /**
     * 根据员工id查询员工薪资信息
     * @param empId 员工id
     * @return 员工调薪记录详情
     */
    @ApiOperation(value="根据员工id查询员工薪资信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empId", dataType = "String", value = "员工id", paramType = "query")
    })
    Result<SalaryChangesVO> getSalaryBasicByEmpId(String empId);


}

